@material/linear-progress

What is @material/linear-progress?

@material/linear-progress is a Material Design component for displaying linear progress indicators. It provides a visual representation of the progress of a task, making it easy to integrate with React applications and ensuring a consistent look and feel with other Material Design components.

What are @material/linear-progress's main functionalities?

Indeterminate Progress

This feature allows you to display an indeterminate progress bar, which is useful when the duration of the task is unknown.

import React from 'react';
import { LinearProgress } from '@material-ui/core';

function IndeterminateProgress() {
  return <LinearProgress />;
}

export default IndeterminateProgress;

Determinate Progress

This feature allows you to display a determinate progress bar, which is useful when you can track the progress of a task.

import React, { useState } from 'react';
import { LinearProgress } from '@material-ui/core';

function DeterminateProgress() {
  const [progress, setProgress] = useState(0);

  React.useEffect(() => {
    const timer = setInterval(() => {
      setProgress((oldProgress) => {
        if (oldProgress === 100) {
          return 0;
        }
        const diff = Math.random() * 10;
        return Math.min(oldProgress + diff, 100);
      });
    }, 500);

    return () => {
      clearInterval(timer);
    };
  }, []);

  return <LinearProgress variant="determinate" value={progress} />;
}

export default DeterminateProgress;

Buffer Progress

This feature allows you to display a buffer progress bar, which is useful when you want to show both the progress and the buffer of a task.

import React, { useState } from 'react';
import { LinearProgress } from '@material-ui/core';

function BufferProgress() {
  const [progress, setProgress] = useState(0);
  const [buffer, setBuffer] = useState(10);

  React.useEffect(() => {
    const timer = setInterval(() => {
      setProgress((oldProgress) => {
        if (oldProgress === 100) {
          return 0;
        }
        const diff = Math.random() * 10;
        return Math.min(oldProgress + diff, 100);
      });
      setBuffer((oldBuffer) => {
        if (oldBuffer === 100) {
          return 10;
        }
        const diff = Math.random() * 10;
        return Math.min(oldBuffer + diff, 100);
      });
    }, 500);

    return () => {
      clearInterval(timer);
    };
  }, []);

  return <LinearProgress variant="buffer" value={progress} valueBuffer={buffer} />;
}

export default BufferProgress;

Query Progress

This feature allows you to display a query progress bar, which is useful when you want to indicate that a task is being queried.

import React from 'react';
import { LinearProgress } from '@material-ui/core';

function QueryProgress() {
  return <LinearProgress variant="query" />;
}

export default QueryProgress;

Other packages similar to @material/linear-progress

react-loader-spinner

react-loader-spinner provides a collection of customizable loading spinners for React applications. It offers a variety of spinner types, including linear progress bars, and is highly customizable in terms of size, color, and animation speed. Compared to @material/linear-progress, it provides more variety in loading indicators but may not adhere strictly to Material Design guidelines.

react-progressbar.js

react-progressbar.js is a React wrapper for ProgressBar.js, a library for creating animated progress bars. It supports linear and circular progress bars with customizable animations and styles. While it offers more animation options compared to @material/linear-progress, it may require more effort to integrate seamlessly with Material Design components.

nprogress

nprogress is a simple and lightweight progress bar library for web applications. It is often used for indicating page load progress and can be easily integrated with React. However, it lacks the variety of progress bar types and customization options available in @material/linear-progress.

README

Linear Progress

The MDC Linear Progress component is a spec-aligned linear progress indicator component adhering to the Material Design progress & activity requirements.

Design & API Documentation

• Guidelines
• Demo

Installation

npm install @material/linear-progress

Basic Usage

HTML Structure

<div role="progressbar" class="mdc-linear-progress" aria-label="Example Progress Bar" aria-valuemin="0" aria-valuemax="1" aria-valuenow="0">
  <div class="mdc-linear-progress__buffer">
    <div class="mdc-linear-progress__buffer-bar"></div>
    <div class="mdc-linear-progress__buffer-dots"></div>
  </div>
  <div class="mdc-linear-progress__bar mdc-linear-progress__primary-bar">
    <span class="mdc-linear-progress__bar-inner"></span>
  </div>
  <div class="mdc-linear-progress__bar mdc-linear-progress__secondary-bar">
    <span class="mdc-linear-progress__bar-inner"></span>
  </div>
</div>

Accessibility

Progress bars conform to the WAI-ARIA Progressbar Specification. The supported ARIA attributes for this progress bar are:

Attribute	Description
aria-label	Label indicating how the progress bar should be announced to the user.
aria-valuemin	The minimum numeric value of the progress bar, which should always be 0.
aria-valuemax	The maximum numeric value of the progress bar, which should always be 1.
aria-valuenow	A numeric value between aria-valuemin and aria-valuemax indicating the progress value of the primary progress bar. This attribute is removed in indeterminate progress bars.

Note that aria-label, aria-valuemin, and aria-valuemax are static and must be configured in the HTML. aria-valuenow is updated dynamically by the foundation when the progress value is updated in determinate progress bars.

RTL Localization

The direction of the progress bar follows the dir attribute on its nearest ancestor. For example, setting dir="rtl" on the progress root reverses the direction of the indicator. Where multiple dir attributes are specified in the tree, the one on the progress bar root takes precedence.

Styles

@use "@material/linear-progress";

@include linear-progress.core-styles;

JavaScript Instantiation

import { MDCLinearProgress } from '@material/linear-progress';

const linearProgress = new MDCLinearProgress(document.querySelector('.mdc-linear-progress'));

See Importing the JS component for more information on how to import JavaScript.

CSS Modifiers

The provided modifiers are:

Class	Description
mdc-linear-progress--indeterminate	Puts the linear progress indicator in an indeterminate state.
mdc-linear-progress--closed	Hides the linear progress indicator.

Sass Mixins

Mixin	Description
bar-color($color)	Sets the color of the progress bar
buffer-color($color)	Sets the color of the buffer bar and dots

Using the Foundation Class

MDC Linear Progress ships with an MDCLinearProgressFoundation class that external frameworks and libraries can use to integrate the component. As with all foundation classes, an adapter object must be provided. The adapter for linear progress must provide the following functions, with correct signatures:

Method Signature	Description
addClass(className: string) => void	Adds a class to the root element.
removeAttribute(attributeName: string) => void	Removes the specified attribute from the root element.
removeClass(className: string) => void	Removes a class from the root element.
hasClass(className: string) => boolean	Returns boolean indicating whether the root element has a given class.
forceLayout() => void	Force-trigger a layout on the root element. This is needed to restart animations correctly.
setAttribute(attributeName: string, value: string) => void	Sets the specified attribute on the root element.
setBufferBarStyle(styleProperty: string, value: string) => void	Sets the inline style on the buffer bar.
setPrimaryBarStyle(styleProperty: string, value: string) => void	Sets the inline style on the primary bar.
attachResizeObserver(callback: ResizeObserverCallback) => ResizeObserver | null	Returns a ResizeObserver that has had observe called on the root with the given callback (for animation performance gains on modern browsers). null if ResizeObserver is not implemented or polyfilled.
setStyle(styleProperty: string, value: string) => void	Sets the inline style on the root element.
getWidth() => number	Returns the width of the root.

MDCLinearProgressFoundation API

MDC Linear Progress Foundation exposes the following methods:

Method Signature	Description
setDeterminate(value: boolean) => void	Toggles the component between the determinate and indeterminate state.
isDeterminate() => boolean	Whether or not the component is in determinate state.
setProgress(value: number) => void	Sets the progress bar to this value. Value should be between [0, 1].
getProgress() => number	The current progress value in the interval [0,1].
setBuffer(value: number) => void	Sets the buffer bar to this value. Value should be between [0, 1].
getBuffer() => number	The current buffer value in the interval [0,1].
open() => void	Puts the component in the open state.
close() => void	Puts the component in the closed state.
isClosed() => boolean	Whether or not the progress indicator is closed.

MDCLinearProgress API

MDC Linear Progress exposes the following methods:

Method Signature	Description
set determinate(value: boolean) => void	Toggles the component between the determinate and indeterminate state.
set progress(value: number) => void	Sets the progress bar to this value. Value should be between [0, 1].
set buffer(value: number) => void	Sets the buffer bar to this value. Value should be between [0, 1].
open() => void	Puts the component in the open state.
close() => void	Puts the component in the closed state.

Changelog

14.0.0 (2022-04-27)

Bug Fixes

• button: update HCM shim to use the existing focus-ring (a657abb)
• checkbox: Add explicit system color for checkmark in HCM. (8c4da22)
• checkbox: move forced-colors theme out of static styles (bbd1126)
• checkbox: Update checkbox theme styles mixin to accept css vars (c14e977)
• chips: Fix typography selector in GMDC-Wiz chips theming (43c7d87)
• datatable: Adjust data table last row border-radius to support setting row background-color. (ba78e87)
• dialog: Render dividers in Firefox 94 on Windows HCM (fae6c65)
• dialog: Set default z-index for close button in FloatingSheet dialog. (3366a71)
• fab: Add focus ring in HCM. (d57ec74)
• focus-ring: add 2d padding customizability, RTL bugfix (f81fb1d)
• focus-ring: box-sizing bugfix to content-box. If box-sizing border-box is inherited the ring spacing will collapse. (e58552c)
• focus-ring: ignore pointer events (3ef470e)
• focus-ring: RTL bugfix (e00181e)
• iconbutton: Fixed max width and height for high contrast mode focus ring on icon buttons. Display only in forced colors mode. (cf42927)
• iconbutton: Set icon button ripple z-index to -1. (586e740)
• list: Improve a11y for multi-select lists (9736ddc)
• list: Remove conflicting validation for checkbox list in setEnabled (353ca7e)
• list: Update lastSelectedIndex when toggling a checkbox range (dcba26f)
• menusurface: Add a getOwnerDocument() method to MDCMenuSurfaceAdapter to provide a reference to the document that owns the menu surface DOM element. (3486659)
• radio: Fix disabled state in Firefox Windows high contrast mode (23043ac)
• radio: Modify theme styles Sass mixin validation to validate only keys (390220e)
• select: Add border to select menu in HCM. (5d80969)
• select: revert down/up arrow on anchor changing selected index (43d08ba)
• slider: Fix bug where secondary click moves slider thumb. (3ab9565)
• slider: Fix IE11 bug - unset is unsupported in IE. (f460e23)
• slider: In updateUI, fix behavior to match jsdoc claim that when thumb param is undefined it updates both thumbs. Input attributes were not being updated at all. (cc4ed13)
• slider: Make the slider errors easier to debug by providing all relevant values in the error message. (8687937)
• snackbar: address Trusted Types violation (cbd9358)
• tooltip: Adjusts logic in validateTooltipWithCaretDistances method. (3e30054)
• typography: Fixes typography theme-styles mixin... the value being retreived from the $theme map and css property name was swapped. The mixin would request font-size/font-weight/letter-spacing from the $theme map (which expects size/weight/tracking)... so these values would always be null. (32b3913)
• Remove /** @override */ tags from TypeScript code. (c3cdff0)
• Simplify MDCAttachable interface to be any object (Function) that has attachTo. (05db65e)
• Snackbar action button ripple color is applied to the ripple element. (4e66fb2)
• Work around bug in Sass (037285f), closes sass/sass#3259
• switch: Restore Firefox 94 HCM outlines (39cf14b)
• textfield: Fix breaking tests due to no valid pointerId being associated with pointer events. (15db4f1)
• tooltip: Only sends notification of a tooltip being hidden if showTimeout is not set (indicating that this tooltip is about to be re-shown). (6ca8b8f)

Features

• banner: Add disableAutoClose params for both banner actions to prevent the banner buttons from automatically closing the banner. Add adapter #notifyActionClicked method. (b094eaa)
• chips: add focus ring styles (783f6fd)
• chips: Added elevation tint layer color support in chips (c78ff04)
• data-table: separate table structure into its own mixin (9f9d928)
• dialog: Add styling for floating sheets (78305b6)
• dialog: Add styling for floating sheets with content padding (3e20c1d)
• Dialog: Adds an API to hide the header for GMDC Fullscreen Dialog in non-fullscreen mode (ab4aba1)
• Dialog: Adds an API to set custom position for GMDC Dialog (ea9b5b4)
• Dialog: Adds an API to set custom z-index for GMDC Dialog (96ea061)
• focus-ring: added a new mixin so we can override just the focus-ring color (641ed08)
• focus-ring: added a new mixin so we can override just the focus-ring radius (7321d62)
• iconbutton: Add link icon button Sass. (9803d2d)
• mdc-list: introduce selection change event (7d8ea46)
• menu: allow preferentially opening surface below anchor (261f2db)
• MenuSurface: Add opening event for menus. (53b3cad)
• select: Add theming mixin boilerplate code to select (ae8a6a3)
• select: Add validation getter methods. (bdf1d37)
• select: Added theme mixins to MDC select (dcfe49c)
• slider: Add minRange param to range sliders to request a minimum gap between the two thumbs. (8fffcb5)
• slider: Add an option to hide focus styles after pointer interaction. (ec54d90)
• slider: Keep the slider value indicator within the bounds of the slider if possible. (c047f7c)
• state: make context aware (b2fe352)
• switch: Add high contrast mode focus ring to switch (f31a833)
• text-field: Add theming mixin boilerplate code to text-field (eb382f3)
• text-field: Added theme mixins to MDC text field (344d528)
• textfield: adding input-font-size mixin (207230e)
• theme: allow custom property strings in theme.validate-theme() (4e372fb)
• add new class and mixin for open state of a menu item (9a02b6e)
• Indicate which thumb valueToAriaValueTextFn and valueToValueIndicatorTextFn functions are called for. (b6510c8)
• textfield: adding input-font-family mixin (991fb99)
• Describe how to add child lists into a list item. (758ce31)

BREAKING CHANGES

• MenuSurface: Adds #notifyOpening method to menu surface adapter.

PiperOrigin-RevId: 444830518

• slider: Adds #getValueIndicatorContainerWidth method to slider adapter.

PiperOrigin-RevId: 419837612